juce/source/extras/the jucer/src/model/jucer_JucerDocument.h

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #ifndef __JUCER_JUCERDOCUMENT_JUCEHEADER__
  27 #define __JUCER_JUCERDOCUMENT_JUCEHEADER__
  28
  29 #include "components/jucer_ComponentTypeHandler.h"
  30 #include "jucer_PaintRoutine.h"
  31 #include "jucer_ComponentLayout.h"
  32 #include "jucer_BinaryResources.h"
  33
  34
  35 //==============================================================================
  36 /**
  37     This is the main document base class, which loads, saves and manages the state of
  38     an entire jucer component.
  39
  40     It contains a ComponentLayout object to represent its sub-components, and
  41     one or more PaintRoutine objects to represent sets of drawing operations it
  42     might want to do.
  43
  44     It also holds a BinaryResources object to manage its resources.
  45 */
  46 class JucerDocument  : public FileBasedDocument,
  47                        private Timer
  48 {
  49 public:
  50     //==============================================================================
  51     JucerDocument();
  52     ~JucerDocument();
  53
  54     void changed();
  55
  56     virtual JucerDocument* createCopy() = 0;
  57     virtual const String getTypeName() const = 0;
  58
  59     //==============================================================================
  60     UndoManager& getUndoManager() throw()                                   { return undoManager; }
  61
  62     bool perform (UndoableAction* const action, const String& actionName);
  63
  64     void refreshAllPropertyComps();
  65
  66     //==============================================================================
  67     const String& getClassName() const throw()                              { return className; }
  68     void setClassName (const String& newName);
  69
  70     const String& getComponentName() const throw()                          { return componentName; }
  71     void setComponentName (const String& newName);
  72
  73     const String getParentClassString() const;
  74     void setParentClasses (const String& classes);
  75
  76     const String getConstructorParams() const;
  77     void setConstructorParams (const String& newParams);
  78
  79     const String getVariableInitialisers() const;
  80     void setVariableInitialisers (const String& newInitlialisers);
  81
  82     void setFixedSize (const bool isFixed);
  83     bool isFixedSize() const throw()                                        { return fixedSize; }
  84
  85     void setInitialSize (int w, int h);
  86
  87     int getInitialWidth() const throw()                                     { return initialWidth; }
  88     int getInitialHeight() const throw()                                    { return initialHeight; }
  89
  90     //==============================================================================
  91     virtual int getNumPaintRoutines() const = 0;
  92     virtual const StringArray getPaintRoutineNames() const = 0;
  93     virtual PaintRoutine* getPaintRoutine (const int index) const = 0;
  94
  95     virtual ComponentLayout* getComponentLayout() const = 0;
  96
  97     virtual Component* createTestComponent (const bool alwaysFillBackground) = 0;
  98
  99     virtual void addExtraClassProperties (PropertyPanel* panel);
 100
 101     //==============================================================================
 102     virtual void getOptionalMethods (StringArray& baseClasses,
 103                                      StringArray& returnValues,
 104                                      StringArray& methods,
 105                                      StringArray& initialContents) const;
 106
 107     void setOptionalMethodEnabled (const String& methodSigniture, const bool enable);
 108     bool isOptionalMethodEnabled (const String& methodSigniture) const throw();
 109
 110     //==============================================================================
 111     BinaryResources& getResources() throw()                                 { return resources; }
 112
 113     //==============================================================================
 114     void setSnappingGrid (const int numPixels, const bool active, const bool shown);
 115
 116     int getSnappingGridSize() const throw()                                 { return snapGridPixels; }
 117     bool isSnapActive (const bool disableIfCtrlKeyDown) const throw();
 118     bool isSnapShown() const throw()                                        { return snapShown; }
 119
 120     int snapPosition (int pos) const throw();
 121
 122     //==============================================================================
 123     void setComponentOverlayOpacity (const float alpha);
 124     float getComponentOverlayOpacity() const throw()                  { return componentOverlayOpacity; }
 125
 126     //==============================================================================
 127     static const char* const jucerCompXmlTag;
 128
 129     /** Creates the document's metadata xml section.
 130
 131         This doesn't include resources, which are done separately.
 132     */
 133     virtual XmlElement* createXml() const;
 134
 135     /** Restores the sub-components and graphics from xml metadata.
 136
 137         This doesn't include resources, which aren't altered.
 138     */
 139     virtual bool loadFromXml (const XmlElement& xml);
 140
 141     static XmlElement* pullMetaDataFromCppFile (const String& cpp);
 142
 143     //==============================================================================
 144     //  Code generation
 145
 146     /** Fills in a GeneratedCode structure with this component's state. */
 147     virtual void fillInGeneratedCode (GeneratedCode& code) const;
 148
 149     virtual void fillInPaintCode (GeneratedCode& code) const;
 150
 151     /** Tries to track down and load the header and cpp templates.
 152     */
 153     bool findTemplateFiles (String& templateH, String& templateCpp) const;
 154
 155     /** Generates and returns the header and cpp file contents for this component. */
 156     void getPreviewFiles (String& header, String& cpp);
 157
 158
 159 protected:
 160     const String getDocumentTitle();
 161     const String loadDocument (const File& file);
 162     const String saveDocument (const File& file);
 163     const File getLastDocumentOpened();
 164     void setLastDocumentOpened (const File& file);
 165
 166
 167 protected:
 168     //==============================================================================
 169     String className;
 170     String componentName;
 171     String parentClasses, constructorParams, variableInitialisers;
 172     bool fixedSize;
 173     int initialWidth, initialHeight;
 174
 175     BinaryResources resources;
 176
 177     static void addMethod (const String& base, const String& returnVal, const String& method, const String& initialContent,
 178                            StringArray& baseClasses, StringArray& returnValues, StringArray& methods, StringArray& initialContents);
 179
 180 private:
 181     UndoManager undoManager;
 182     int snapGridPixels;
 183     bool snapActive, snapShown;
 184     Component* lastFocusedComp;
 185     int lastClickCounter;
 186     float componentOverlayOpacity;
 187
 188     StringArray activeExtraMethods;
 189
 190     void timerCallback();
 191
 192     //==============================================================================
 193     const String getMetadata() const;
 194
 195     bool writeCodeFiles (const File& headerFile,
 196                          const File& cppFile,
 197                          String headerTemplate,
 198                          String cppTemplate) const;
 199 };
 200
 201
 202 #endif   // __JUCER_JUCERDOCUMENT_JUCEHEADER__